[CI] Speed up documentation check #4777
Conversation
It is sufficient to check check one output format for errors.
With this patch we gain a massive performance improvement, resulting also in less processor cycles and therefore less energy consumption.
Previously, on documentation testing (locally):
Parsing: 814/814 [============================] 100% Parsed 814 files in 17.35 seconds
Rendering: 814/814 [===========] 100% Output format html: Rendered 814 documents in 48.17 seconds
Rendering: 814/814 [============================] 100% Output format singlepage: Rendered 814 documents in 3.51 seconds
Rendering: 814/814 [============================] 100% Output format interlink: Rendered 814 documents in 0.05 seconds
Successfully placed 814 rendered HTML, SINGLEPAGE, and INTERLINK files into /project/Documentation-GENERATED-temp
With this patch (locally):
Parsing: 814/814 [============================] 100% Parsed 814 files in 17.71 seconds
Rendering: 814/814 [============================] 100% Output format singlepage: Rendered 814 documents in 8.24 seconds
Successfully placed 814 rendered SINGLEPAGE files into /project/Documentation-GENERATED-temp
Releases: main, 12.4
|
If this gets in, I will take care of adjusting the docs check in the other repos. |
|
I can remember that I was trying this in the beginning and there was some backside to it. So I would suggest we first try this out in one repository and if we recognize no ill effects roll it out after a week or two |
Hmm, I added an error locally in an rst file, and the error was recognised (as it should). That's the reason for this workflow step, to recognise errors, isn't it? |
There was a problem hiding this comment.
Thanks for the initiative! We do need to do something about it.
I wonder though if we should do a more flexible approach here, maybe by adding a argument like "--minimal-test" or so. Then we could internally set the output directive.
This would allow us to only change it once in other repositories and if we spot errors or further optimization, it can all be done within the container, without changing any repositories...?
|
I really like that idea! |
|
I would suggest we try out the changes in this one manual but prepare to switch it to the suggested better form of having a "--minimal-test" parameter. |
|
@brotkrueml please do not roll out to other manuals, but make a ticket in https://github.com/TYPO3-Documentation/render-guides/issues |
Feel free to create that ticket ;-) |
|
I am on it |
It is sufficient to check one output format for errors (here "singlepage"). With this patch we gain a massive performance improvement, resulting also in less processor cycles and therefore less energy consumption.
Previously, on documentation testing (locally):
With this patch (locally):
Releases: main, 12.4, 11.5